Skip to content

[spark] use CamelCase in config names#3471

Open
fresh-borzoni wants to merge 1 commit into
apache:mainfrom
fresh-borzoni:spark-config-camelcase
Open

[spark] use CamelCase in config names#3471
fresh-borzoni wants to merge 1 commit into
apache:mainfrom
fresh-borzoni:spark-config-camelcase

Conversation

@fresh-borzoni

Copy link
Copy Markdown
Member

closes #3462

making SparkConfig consistent

@fresh-borzoni

Copy link
Copy Markdown
Member Author

@Yohahaha @YannByron @luoyuxia PTAL 🙏

@Yohahaha Yohahaha left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late reply.

I think we should keep the current dot-style configuration. For longer configuration names, use camelCase. for scan.maxRecordsPerPartition, scan represents the configuration module, and maxRecordsPerPartition represents a specific setting within the scan module. This naming convention is also used in Spark, for example spark.sql.optimizer.xxx


val SCAN_POLL_TIMEOUT: ConfigOption[Duration] =
ConfigBuilder
.key("scan.poll.timeout")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scan.pollTimeout

@Jackeyzhe

Copy link
Copy Markdown
Contributor

One small question: the deprecation path — is there a plan to keep the old snake_case names working with
a @Deprecated(since="...") annotation and a log warning when read, or do you plan a hard 0.x → 0.y cut-off? If the latter, please call out the migration note in the PR description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[spark] use CamelCase in spark configs

3 participants